Self-describing device module and system and computer-readable medium for the production thereof

ABSTRACT

A system, method, and computer-readable medium for generation of a controlled device Module are provided. Various components are provided to a Module designer for selection, and the designer defines the interface APIs specifying the component functionalities. The designer may specify custom commands or events for the Module including Commands, Properties, and Parameters, and custom components corresponding to the custom commands are generated. A self-describing capabilities component is then generated for each component, and a composite capabilities component may then be generated from the capabilities components of each of the components. The completed Module package is then produced by an integrated development environment station.

CROSS REFERENCE TO RELATED APPLICATIONS

This application is a continuation of and claims priority to U.S. patentapplication Ser. No. 14/853,170, entitled “SELF-DESCRIBING DEVICE MODULEAND SYSTEM AND COMPUTER-READABLE MEDIUM FOR THE PRODUCTION THEREOF”,filed Sep. 14, 2015, now issued U.S. Pat. No. 9,792,113, issued on Oct.17, 2017, which is a continuation of U.S. patent application Ser. No.13/674,178, entitled “SELF-DESCRIBING DEVICE MODULE AND SYSTEM ANDCOMPUTER-READABLE MEDIUM FOR THE PRODUCTION THEREOF”, filed Nov. 12,2012, now issued U.S. Pat. No. 9,134,719, issued on Sep. 15, 2015, whichis a continuation of U.S. patent application Ser. No. 12/344,716,entitled “SELF-DESCRIBING DEVICE MODULE AND SYSTEM AND COMPUTER-READABLEMEDIUM FOR THE PRODUCTION THEREOF”, filed Dec. 29, 2008, now issued U.S.Pat. No. 8,316,343, issued Nov. 20, 2012, which in turn claims priorityto U.S. provisional patent application Ser. No. 61/017,613, entitled,“Self Describing Devices”, filed Dec. 29, 2007, by Birze, et al. andU.S. provisional patent application Ser. No. 61/017,620, entitled,“Server Enabled Device Description”, filed Dec. 29, 2007, by Birze, etal., the disclosures of which is incorporated herein by reference.

FIELD OF THE INVENTION

The present invention is generally related to control systems and, moreparticularly, to self-describing controlled device modules in a controlsystem.

BACKGROUND OF THE INVENTION

Many systems, such as control systems, monitoring systems, and the like,exist that allow discovery at runtime of devices active in the system.These systems may also discover a device's type thereby allowing basiccontrol and monitoring with no external configuration. However, thesesystems depend on standardized application programming interfaces (APIs)describing Parameters, Properties, and Control Commands for differentdevice types. Once a device of a known device type is found, the systemcan use a standardized API for the device type to control, configure, ormonitor the device. For example, some of the attributes of securitysystem device types include Properties, such as a manufacture and model,Parameters, such as arm-able state (ability to arm a system) andsecurity state, (such as ARM_HOME, ARM, DISARM, and PANIC), and Commands(such as GetSecurityStatus, setSecurityState, and isOKToArm).

Unfortunately, many devices have capabilities that do not fit intostandardized device type APIs. This particular trend is becoming moreprevalent as manufacturers merge multiple capabilities into a singledevice, e.g., placing a DVD and a VCR in the same device housing.

Companies that support standardized device type APIs must frequentlyupdate their APIs to keep up with the latest innovations by devicemanufactures. This causes deployment issues as the control, monitoring,and integration systems that understand the APIs must be updated tounderstand devices using the latest APIs.

Many device protocols allow manufactures to add extensions to theirdevice type API to allow the manufacturers to expose their devices'unique capabilities. However, custom code must then be developed andinstalled in the control or monitoring system to allow the system toutilize a device's extensions thereby requiring intimate knowledge ofthe control or monitoring system's internals. Additionally, custom codein a control or monitoring system hampers the ability to swap one deviceof a type for another of the same type. For example, custom code writtenfor a receiver with custom capabilities will not perform when thereceiver is swapped for one that does not have the custom capabilities.

Therefore, what is needed is a mechanism that overcomes the describedproblems and limitations.

SUMMARY OF THE INVENTION

The present invention provides a controlled device Module and a methodand computer-readable medium for generation thereof. A development IDEpresents various SDK components for selection to a Module designer toinclude selected SDK components in the Module. The designer is thenprovided an environment by the development IDE to supply or otherwisedefine the interface API specifying the SDK component functionality. Thedesigner may be provided an option to specify custom commands or eventsfor the Module. If the designer elects to supply a custom command orevent, the custom command is supplied to the IDE by the designer for theModule. After specification of the custom command or event andcorresponding Commands, Properties, and/or Parameters and associateddescriptive text and metadata, the IDE generates a custom componentcorresponding to the custom command. The IDE then generates aself-describing capabilities component for each SDK component and customcomponent. The IDE may then generate capabilities classes for theModule. A composite capabilities component may then be generated fromthe capabilities components of each of the SDK and custom components. Amanifest may then be generated for the Module that specifies a genericrouter that is adapted to interface with the self-describing Module. Thecompleted Module package is then produced by the IDE.

In one embodiment of the disclosure, a method of generating a controlleddevice module is provided. The method comprises providing a plurality ofsoftware development kit components for inclusion in the module,receiving selection of at least one software development kit componentof the plurality of software development kit components, receiving adefinition of an application programming interface for the at least onesoftware development kit component, receiving a custom command for themodule, generating, by an integrated development environment station, acustom component corresponding to the custom command, and generating acapabilities component from the definition of the applicationprogramming interface and the custom component.

In a further embodiment of the disclosure, a computer-readable mediumhaving computer-executable instructions for execution by a processingsystem, the computer-executable instructions for generating a controlleddevice module is provided. The computer-readable medium includesinstructions that, when executed, cause the processing system to providea plurality of software development kit components for inclusion in themodule, receive selection of at least one software development kitcomponent of the plurality of software development kit components,receive a definition of an application programming interface for the atleast one software development kit component, generate a softwaredevelopment kit component class corresponding to the selected softwaredevelopment kit component, generate a device component classcorresponding to the selected software development kit component fromthe definition of the application programming interface, receive acustom command for the module, generate, by an integrated developmentenvironment station, a custom component corresponding to the customcommand, and generate a capabilities component from the definition ofthe application programming interface and the custom component.

In a further embodiment of the disclosure, a controlled device modulefor deployment in a control system that facilitates control andmonitoring of a controlled device is provided. The module is implementedas executable instructions tangibly embodied on a computer-readablemedium comprising a software development kit component class, a customfeatures class defined by one or more custom commands, a devicecomponent class corresponding to the software development kit component,a custom device component class corresponding to the custom featuresclass, and a capabilities class configured to query the device componentclass for capabilities associated therewith and query the custom devicecomponent class for capabilities associated therewith, wherein thecapabilities class is adapted to generate a composite capabilitiesobject based on capabilities associated with the device component classand capabilities associated with the custom device component class.

BRIEF DESCRIPTION OF THE DRAWINGS

Aspects of the present disclosure are best understood from the followingdetailed description when read with the accompanying figures, in which:

FIG. 1 is a diagrammatic representation of a contemporary control systemconfiguration that provides for control and monitoring of controlleddevices deployed in the control system;

FIG. 2 is a diagrammatic representation of a control systemconfiguration that facilitates controlled device Module development anddeployment in accordance with embodiments;

FIG. 3 is a diagrammatic representation of a controlled device Moduleand controlled device development and deployment work flow implementedin accordance with an embodiment;

FIG. 4 is a flowchart that depicts a controlled device Module creationroutine implemented in accordance with an embodiment; and

FIG. 5 is a diagrammatic representation of a Module package classstructure implemented in accordance with disclosed embodiments.

DETAILED DESCRIPTION OF THE INVENTION

It is to be understood that the following disclosure provides manydifferent embodiments or examples for implementing different features ofvarious embodiments. Specific examples of components and arrangementsare described below to simplify the present disclosure. These are, ofcourse, merely examples and are not intended to be limiting.

In accordance with disclosed embodiments, a self-describing controlleddevice Module allows a device to describe itself both at runtime andbefore installation thereby allowing discovery of the capabilities ofthe device to enable control, monitoring, and integration of a devicewith no prior knowledge of the device or the device type. Additionally,custom extensions to a device's capabilities will also be discovered toallow control, monitoring, and integration of these custom extensionswithout the need for custom code. New devices may then be deployed, orcommunicatively coupled with, control systems, monitoring systems,configuration tools, or development tools and natively understood withno changes to the systems or tools.

Contemporary products may use application programming interfaces andcorresponding device types to provide integration and control of devicesin a control system. Exemplary attributes of the Security System devicetype include Properties, such as manufacture and model, Parameters, andCommands. However, many devices have capabilities that do not fit intosuch standardized APIs, and the trend is becoming more prevalent asmanufacturers merge multiple capabilities into a single device.

In accordance with disclosed embodiments, mechanisms for provisioning aself-describing controlled device Module are provided. As referred toherein a device Module comprises a component that allows a device to bedeployed in a control or remote monitoring system (collectively referredto herein simply as a control system). The device Module may beimplemented as computer-executable or computer-readable instructionstangibly embodied on a computer-readable medium. A device, such as acamera, tuner, or any other device that may be monitored, controlled, orotherwise manipulated via the control system, is referred to herein as acontrolled device. A controlled device has a corresponding device Modulethat facilitates deployment and operation of the controlled devicewithin the control system. The control system may include various systementities or nodes that facilitate controlled device configuration anddeployment, management, operation, control, monitoring, or othermanipulations of a controlled device. Control system entities arereferred to herein as control system devices (or simply system devices).Exemplary system devices include, for example, a master controller, aremote monitoring system (RMS), and any variety of IntegratedDevelopment Environment (IDE) systems or tools used for deviceintegration, deployment or configuration.

The self-describing device Modules implemented according to disclosedembodiments are able to describe the capabilities of a controlled deviceboth at runtime and before installation. Advantageously, the discoveryof the capabilities of the device by other system devices with no priorknowledge of the device or its device type is provided. A mastercontroller is able to control the controlled device, an RMS is able tomonitor the controlled device, and an integration IDE is able tointegrate the device Module with no changes to other control systemdevices. Additionally, custom extensions to device APIs may be allowedand may also be discoverable to allow control, monitoring, andintegration of these custom extensions without the need for custom code.

FIG. 1 is a diagrammatic representation of a contemporary control system100 configuration that provides for device control and monitoring incontrol system 100. A controlled device development IDE 110 may be usedby device manufactures, e.g., a manufacturer of a controlled device 170,to develop a Module for the corresponding controlled device.Alternatively, the development IDE 110 may be used by manufacturers ordevelopers of control system devices. A Module provides customizedcontrol and monitoring for a specific controlled device model from aspecific manufacturer in a control system 100.

An integration IDE 130 allows device dealers to easily integratemultiple Modules and their associated controlled devices into a singlecontrol system 100. An integration tool run at integration IDE 130 mayprovide a visual mechanism of generating Touchpanel glue code to tie,for example, touch panel 142 inputs with each device Module's API tocontrol and monitor the associated device.

Modules integrated with integration IDE 130 may be loaded onto a mastercontroller 140 to enable control of the corresponding devices in thecontrol system 100. NetLinx code generated by integration IDE 130 mayalso be loaded onto the master controller 140 to link touch panels, orother peripheral devices, with the control and monitoring APIs exposedby the device Modules generated by development IDE 110.

A remote monitoring system (RMS) 160 may feature a resource managementsuite that provides remote monitoring and control of various controlleddevices 170 integrated in control system 100. The RMS 160 may comprisean RMS server that communicates with RMS agents installed on the systemmaster controller 140. The RMS enables administrators to gather statusof controlled devices and to control the devices participating in thecontrol system 100 that are deployed via the master controller 140.Various control system devices are communicatively coupled with oneanother, e.g., via a network 150, a direct connection, or anothersuitable interface.

Contemporary API specifications create a control system which providesrigid device development, yet does not provide effective runtimeenforcement. This introduces ambiguity and creates issues for controlsystem devices or products collaborating to provide control andmonitoring for controlled devices deployed in control system 100.

A control system device software development kit (SDK) composed of SDKcomponents is used to create Modules for controlled devices. SDKcomponents each expose an API that describes the mechanisms forcontrolling and monitoring the common device component. For example, aPower Supply is a device component used in many device types and thusmay have a corresponding Power Supply SDK component at the developmentIDE 110.

Typical SDK components are grouped into well know device types which arerigid in their structure. These well known device types cannot easilyaccount for device innovations in the form of new functionality orcombinations of different device types. For example, a VCR comprises apower supply, a television tuner, and a tape transport. A device typespecified as a VCR may then have a respective SDK component for thepower supply, television tuner, and the tape transport. In a similarmanner, a DVD player comprises a power supply and a disc transport. Adevice type specified as a DVD player may have a respective SDKcomponent for the power supply and the disc transport. In this manner,well known device types may be accommodated by various automated toolsfor configuration and deployment in a control system. However, considera manufacturer that has produced a DVD/VCR combination. In thisinstance, another device type must be defined for efficient deploymentof the DVD/VCR combination since neither the SDK components grouped intothe VCR device type nor the SDK components of the DVD device type mayappropriately address the combination device. Module developers may addcustom capabilities as custom events, but these are not nativelyunderstood by any tools or control system devices or products requiring,for example, custom Touchpanel code to utilize the unique devicecapabilities. Thus, a device SDK must be disadvantageously updatedperiodically to accommodate new or modified device types. Consequently,controlled device deployment issues are often encountered as the systemmaster controller 140 can support only one version of the device APIs.If an updated API “breaks” a legacy Module's existing functionality, thelegacy Module must be “reopened” to account for the updated APIs inorder to function on new control system installations. This ongoing SDKand Module maintenance consumes software engineering and developmenttime, aggravates system partners that may not be aware of SDK updates,and complicates integration and deployment for product dealers.

Integration IDE 130 may import a Module's generated module.xml file todetermine the device type and the Commands, Parameters, and Propertiesavailable for the Module. This data is checked against the expectedCommands, Parameters, and Properties for the device type from the mostrecent Device SDK API. If there is a mismatch due to an out of dateModule, the mismatched commands will not appear in the code builder andthus will not be available to the system integrator. Custom commands andevents representing extensions to the standard device type are notexposed to integration IDE 130 and cannot be exposed to the systemintegrator.

In accordance with disclosed embodiments, a device Module configurationrelaxes the rigidity of development while enforcing runtime access toonly defined Commands, Parameters, and Properties. This shift inperspective eliminates the frustration of Module developers not beingable to “fit” their device capabilities into a pre-defined device SDK.Module developers are able to mix and match standard SDK components toaccommodate new device combinations while also creating custom commandsand events to capture unique device capabilities in accordance withdisclosed embodiments. A development IDE captures this information andgenerates a framework that describes the capabilities of the Module.

Central to the disclosed controlled device Module implementation is thecreation of a capabilities component. When queried, a Module'scapabilities component is able to describe its Module's capabilitiesboth as a capabilities object that can be queried at runtime and in anXML format, or other instruction set, that can be saved or passed inmessages between control system devices, such as the master controllerand RMS. This same capabilities component will be able to create aruntime capabilities object from consuming the self-describing XML file.

FIG. 2 is a diagrammatic representation of a control systemconfiguration that facilitates controlled device Module development anddeployment in accordance with embodiments.

A controlled device Module development IDE 210 may be used by controlleddevice manufactures, e.g., manufacturers of controlled and monitoreddevices 270-271, or control system device manufacturers to developself-describing Modules for corresponding controlled devices.

An integration IDE 230 allows device dealers to integrate multipleModules and their associated controlled devices into a single controlsystem. An integration code builder tool run at integration IDE 230 mayprovide a visual mechanism of generating Touchpanel glue code to tie,for example, touch panel inputs with each device Module's API to controland monitor the associated controlled device.

Modules integrated with integration IDE 230 may be loaded onto a systemmaster controller 240 to enable control of the controlled devices in thecontrol system 200.

An RMS 260 provides remote monitoring and control of various controlleddevices 270-271 integrated in control system. The RMS may comprise aresource management suite that communicates with RMS agents installed onthe system master controller 240. RMS 260 enables administrators togather status of controlled devices and to control the devicesparticipating in the control system deployed via master controller 240.

Each Module facilitates control and monitoring for a correspondingcontrolled device in control system. In accordance with an embodiment, aModule package 290 is produced by development IDE 210 that includes thedevice Module 292 and a capabilities component (CC) 293 that facilitatesdevice deployment and operation within the control system. In accordancewith an embodiment, a CC is provided for each controlled device type.Thus, controlled device 270 may have a CC 293 associated therewith, andcontrolled device 271 may have a CC 295 associated therewith. The RMS260 may access each CC 293 and 295 of associated controlled devices270-271. The Module package, such as Module package 290, and constituentcomponents are associated with a particular controlled device, such ascontrolled device 270. A corresponding capabilities component 293includes a self-describing XML file 296, or other suitable instructionset, that specifies the capabilities of the corresponding controlleddevice 270 including Properties, such as the device manufacturer andmodel, Parameters, such as controlled device 270 parameter states andstatus, and commands. As referred to herein, Parameters are mutablevalues describing the state of the controlled device. Parameters can bequeried or delivered as asynchronous events. Properties are immutablevalues describing the controlled device, such as a manufacturer andmodel. Control Commands comprise methods which can be invoked to controlthe device to change the controlled device 270 configuration or state.

A capabilities component, such as CC 293, is configured to be queried byone or more control system devices including configuration, integration,and deployment tools, e.g., integration IDE 230 and RMS 260, and returnModule capabilities in response to the query. The Module capabilitiesmay be provided by the capabilities component as the XML file 296 priorto complete operational configuration of the Module 292 andcorresponding controlled device 270. Further, the self-describing XMLfile 296 may be conveyed between one or more control system devices orcomponents. When the device Module 292 and corresponding controlleddevice 270 are operationally deployed within the control system, acorresponding capabilities component 293 may generate a capabilitiesobject 298 from the self-describing XML file 296. At this point,response to runtime queries issued to the capabilities component 293 maybe provided by the capabilities object 298.

Various control system devices, such as the integration IDE 230, RMS260, and master controller 240 may access a respective capabilitiescomponent, such as CC 293. The capabilities component allows for strictenforcement during integration of the corresponding controlled device270 within the control system and during controlled device 270 runtime.

The controlled device 270 is coupled with the master controller 240 andis thereby provisioned a communication interface with the correspondingModule 292. When the Module and controlled device are operationallyconfigured within the control system, supported control and monitoringcommands may be conveyed from the Module 292 to the controlled device270. To this end, the controlled device Module may communicativelyinterface with a remote monitoring agent 246 that, itself, may becommunicatively coupled with RMS 260, e.g., via a network connection, adirect connection, or other suitable communication medium. The remotemonitoring agent 246 may include or interface with an instance of theself-describing XML file 296. At runtime, the remote monitoring agent246 may obtain the capabilities component 293 in the form of thecapabilities object 298. When the controlled device is registered withRMS 260, an administrator may issue control and monitoring commands thatare received by the remote monitoring agent 246 associated with thecontrolled device 270.

The controlled device Module 292 additionally interfaces with acontrolled device router 244 that is allocated for, and associated with,the controlled device 270. The router 244 is identified and loaded bythe master controller 240 to enable communications between Touchpanelcode 242 and the code environment, e.g., Java, in which Module 292 isdeployed. To this end, Module 292 may include a manifest that specifiesthe router 244 to be loaded and associated with Module 292, and mastercontroller 240 is configured to examine the Module's manifest for suchpurposes. When loaded, the router 244 will query the associated Module292 to discover its capabilities via a returned capabilities object(illustratively represented as a capabilities component 298). Only thecapabilities described by the Module 292 will be sent to, or receivedfrom, the router 244. Commands or monitoring requests conveyed to therouter 244 that are not included in the Module's capabilities objectwill be returned with a “not implemented” error or other suitable fault.Other controlled devices 271-272 may have corresponding Modules,associated RMS agents, and routers configured on master controller 240.

The control system 200 may accommodate controlled devices, such as acontrolled device 271, that has a legacy controlled device Module 294, acorresponding router 245, and RMS agent 247. Legacy controlled deviceModule 294 does not have the ability to provide capabilities of thecontrolled device 273, both rather may only provide a device type andversion, e.g., to remote monitoring agent 246.

FIG. 3 is a diagrammatic representation of a controlled device Moduleand controlled device development and deployment work flow 300implemented in accordance with an embodiment.

A device Module is produced at development IDE 210 (step 302). Thecontrolled device Module 292 created at the development IDE 210 includesa self-describing capabilities XML file 296 for use prior to completeconfiguration of the controlled device 270 and corresponding Module 292within control system. The Module 292 includes suitable logic forcreating and exposing a capabilities object 298 and/or a self-describingXML file 296 for use at runtime, i.e., when the controlled device andModule are operationally configured for use in control system 200. Anintegration IDE 230 may then access the controlled device Module 292 toobtain the self-describing XML file 296 (step 304). On receipt of theself-describing XML file 296, the integration IDE 230 use the XML file296 to integrate the controlled device's exposed capabilities into thecontrol system. Once the device's capabilities are integrated into thecontrol system such that the controlled device and Module areoperationally configured, the master controller 240 may retrieve theruntime capabilities object from the Module 292 and thereby controlaccess to the Module and the corresponding controlled device (step 306).The master controller utilizes the runtime capabilities object 298 toallow or prohibit monitoring requests and commands issued for thecontrolled device 270 according to the capabilities advertised orotherwise provided by the capabilities object 298. The remote monitoringsystem 260 may likewise obtain the controlled device Module'scapabilities object (step 308), and the remote monitoring system mayregister the controlled device accordingly (step 310). The remotemonitoring system uses the capabilities description provided by thecapabilities object to advertise the device capabilities to a remotemonitoring system administrator. The administrator may then complete amonitoring and control configuration for the device that is constrainedby the device capabilities advertised by the controlled devicecapabilities object. Monitoring and control of the controlled device maythen be performed by issuance of suitable commands from the remotemonitoring system to the device Module 292 (step 312).

The development IDE 210 used for creation of the device Module accordingto step 302 may include an SDK that features low-level, reusable,controlled device SDK component building blocks, e.g., power supply, keypad, sensor device, or other common SDK components. However, the use ofSDK components for creation of a Module 292 implemented in accordancewith embodiments advantageously does not rely on module indexing, e.g.,the association of one or more SDKs with a particular controlled devicetype. Rather, SDK components that are available and that may be utilizedfor Module development are not bound by a particular device type, andthus Module developers may freely mix and match SDK components. Further,the SDK preferably provides mechanisms for creating custom events andcommands for the controlled device that may be accommodated by thecorresponding Module. Advantageously, development and deployment ofcontrolled devices within control system does not require any rigidnotion of a device type and a required SDK components association.Module developers are able to create their own device types or,alternatively, start with a known device type and remove or add SDKcomponent at will.

Completed controlled device Modules developed at development IDE 210 arepackaged for installation on master controllers. Completed Modulesemploy a capabilities component 293 to allow the Module to provide adescription of the services it offers as both a runtime capabilitiesobject 298 and in a self-describing XML file 296.

FIG. 4 is a flowchart 400 that depicts a controlled device Modulecreation routine implemented in accordance with an embodiment. Theprocessing steps of FIG. 4 may be implemented as computer-executableinstructions executable by a processing system, such as the developmentIDE 210 depicted in FIG. 2.

The Module creation routine is invoked (step 402), and the Moduledesigner may be presented with various SDK components for selection toinclude in the Module for a corresponding device component (step 404).If the designer selects an SDK component, the metadata on the API isthen specified including valid parameter ranges and values,descriptions, etc. (step 406). Specification of the interface API mayinclude specifying one or more commands, parameters, and/or propertiesand may include the specification of metadata including descriptions,parameters types, and valid ranges. Once the selected SDK componentfunction's interface API has been defined by the designer, the designermay choose an additional SDK component according to step 404.

When no additional SDK components are selected by the Module designer,the designer may be provided an option to specify custom commands (step408). If the designer so chooses, the designer may extend a customcomponent API by the specification of custom commands or events for theModule 292 (step 410). In an embodiment, the IDE 210 may providerequired fields to facilitate generation of a corresponding customcomponent. For example, the IDE 210 may require the designer to specifyone or more Commands, Properties, and Parameters that are to beassociated with the custom command or event, and may require the supplyof metadata including descriptive text and valid ranges of the one ormore Commands, Properties, or Parameters. After specification of thecustom command or event and corresponding Commands, Properties, and/orParameters and associated descriptive text and metadata, the IDE 210 maythen generate a self-describing capabilities component for theSDK/custom component (step 412). The custom component generated by IDE210 encapsulates the device's custom commands and events.

Thereafter, the IDE 210 may then generate a device class skeleton forthe SDK and custom component (step 414). A device class implementationis then added to control the specific device (step 416). A compositecapabilities component may then be generated from each of thecapabilities and custom components (step 418). In an embodiment, thecomposite capabilities component may comprise a self-describing XML file296 from which Module 292 may generate a runtime capabilities objectwhen Module 292 is operationally configured and deployed in controlsystem. A manifest may then be generated for Module 292 (step 420). Inan embodiment, the manifest generated for the Module 292 may specify ageneric router 244 that is adapted to interface with self-describingModule 292. The completed Module package 290 is then produced by IDE 210(step 422). In an embodiment, the Module package 290 includes thegenerated manifest, the chosen SDK components, custom components, andthe composite capabilities component 293 including the generatedself-describing XML file 296. The Module creation routine cycle may thenend (step 424).

FIG. 5 is a diagrammatic representation of a Module package 290 classstructure 500 implemented in accordance with disclosed embodiments.Module package 290 may be implemented as instruction sets tangiblyembodied on a computer-readable medium and executable by a processingsystem, such as development IDE 210.

In the illustrative example, the Module package 290 class structure 500depicts an exemplary class diagram of a packaged Module for control of acontrolled device comprising a tuner 510. The module package 290 mayinclude various device SDK component classes including, for example, aDevice Power SDK class 531, a Device Preamp SDK class 532, and a DeviceTuner SDK class 533. Additionally, a Device Custom Features class 530specifies custom commands or events specific to tuner 510. Correspondingdevice component classes are generated for each of the SDK classes andthe custom class(es). For example, a Power Device Component class 541 isgenerated and included in the Module package that corresponds to theDevice Power SDK class 531. Likewise, a Preamp Device Component class542 is included in the Module package 290 that corresponds to the DevicePreamp SDK class 532, and a Tuner Device Component class 543 is includedin the Module package 290 that corresponds to the Device Tuner SDK class533. A Custom Device Component class 540 is generated by the developmentIDE 210 and provides the API to the custom commands, events, andlisteners specific to the tuner 510 that are provided by the DeviceCustom Functions class 530. All Device SDK Component classes 541-543inherit from a Device Component base class 570 which provides aconsistent interface to the OSGi framework.

Each of the Device SDK classes 531-533 comprise abstract classes thatare selected by the Module developer, e.g., at step 404 described withreference to FIG. 4. The Module developer specifies the interface APIsproviding the functionality of the abstract SDK classes 531-533, e.g.,at step 406 of FIG. 4, thereby providing the requisite logic for thecorresponding device component classes 541-543 to implement specificdevice access codes for properly interfacing with tuner 510. The Moduledeveloper specifies custom commands or events for defining the DeviceCustom Features class 530, e.g., at step 408 of FIG. 4. Custom DeviceComponent class 540 is generated by the development IDE 210, e.g., atstep 410 of FIG. 4, and provides the API to the custom commands, events,and listeners specific to the tuner 510 that are provided by the DeviceCustom Functions class 530. A utility access class, e.g., Serial AccessUtility class 520, may be provisioned at the development IDE 210 tosimplify development of device component classes 540-543 andcorresponding API specifications for utility access via SDK Componentclasses 531-533 and custom classes, e.g., Device Custom Functions class530.

In accordance with an embodiment, Module package 290 and control systemsoftware entities are implemented in compliance with the OSGi framework,although other suitable frameworks may be substituted therefore. An OSGiDevice class 560 and Capabilities class 550 are hidden from the Moduledeveloper. The OSGi Device class 560 provides interaction with the OSGiframework and is the communication point for all services outside theModule bundle. The Capabilities class 550 is generated by developmentIDE 210 and determines all the components and custom commands andlistener events specified in the Module. In an embodiment, theCapabilities class 550 uses Java reflection to match the commands,parameters, and properties listed in the capabilities Object with theactual methods in the objects that satisfy the capabilities.

At startup, each Device Component class 540-543 will be queried fortheir runtime capabilities object that includes the commands,parameters, and properties offered by the Module as well as metadataincluding descriptions, parameters types, and valid ranges. Individualcapabilities objects of Component classes 540-543 may be accumulated bythe Capabilities class 550 for collection of composite capabilities ofall device component classes 540-543. When queried, the OSGi Deviceclass 560 obtains the composite capabilities from the Capabilities class550 and returns a composite runtime capabilities object describing thecapabilities of device 510. The OSGi Device class 560 exposes a serviceinterface other services will use to invoke command or request parameteridentifiers from the associated Capabilities Object.

As described, mechanisms for generation of a controlled device Moduleare provided. A development IDE presents various SDK components forselection to a Module designer to include selected SDK components in theModule. The designer is then provided an environment by the developmentIDE to supply or otherwise define the interface API specifying the SDKcomponent functionality. The designer may be provided an option tospecify custom commands or events for the Module. If the designer electsto supply a custom command or event, the custom command is supplied tothe IDE by the designer for the Module. After specification of thecustom command or event and corresponding Commands, Properties, and/orParameters and associated descriptive text and metadata, the IDEgenerates a custom component corresponding to the custom command. TheIDE then generates a self-describing capabilities component for each SDKcomponent and custom component. The IDE may then generate capabilitiesclasses for the Module. A composite capabilities component may then begenerated from the capabilities components of each of the SDK and customcomponents. A manifest may then be generated for the Module thatspecifies a generic router that is adapted to interface with theself-describing Module. The completed Module package is then produced bythe IDE.

The flowchart of FIG. 4 depicts process serialization to facilitate anunderstanding of disclosed embodiments and is not necessarily indicativeof the serialization of the operations being performed. In variousembodiments, the processing steps described in FIG. 4 may be performedin varying order, and one or more depicted steps may be performed inparallel with other steps. Additionally, execution of some processingsteps of FIG. 4 may be excluded without departing from embodimentsdisclosed herein.

The illustrative block diagrams depict process steps or blocks that mayrepresent modules, segments, or portions of code that include one ormore executable instructions for implementing specific logical functionsor steps in the process. Although the particular examples illustratespecific process steps or procedures, many alternative implementationsare possible and may be made by simple design choice. Some process stepsmay be executed in different order from the specific description hereinbased on, for example, considerations of function, purpose, conformanceto standard, legacy structure, user interface design, and the like.

Aspects of the present invention may be implemented in software,hardware, firmware, or a combination thereof. The various elements ofthe system, either individually or in combination, may be implemented asa computer program product tangibly embodied in a machine-readablestorage device for execution by a processing unit. Various steps ofembodiments of the invention may be performed by a computer processorexecuting a program tangibly embodied on a computer-readable medium toperform functions by operating on input and generating output. Thecomputer-readable medium may be, for example, a memory, a transportablemedium such as a compact disk, a floppy disk, or a diskette, such that acomputer program embodying the aspects of the present invention can beloaded onto a computer. The computer program is not limited to anyparticular embodiment, and may, for example, be implemented in anoperating system, application program, foreground or background process,driver, network stack, or any combination thereof, executing on a singleprocessor or multiple processors. Additionally, various steps ofembodiments of the invention may provide one or more data structuresgenerated, produced, received, or otherwise implemented on acomputer-readable medium, such as a memory.

Although embodiments of the present invention have been illustrated inthe accompanied drawings and described in the foregoing description, itwill be understood that the invention is not limited to the embodimentsdisclosed, but is capable of numerous rearrangements, modifications, andsubstitutions without departing from the spirit of the invention as setforth and defined by the following claims. For example, the capabilitiesof the invention can be performed fully and/or partially by one or moreof the blocks, modules, processors or memories. Also, these capabilitiesmay be performed in the current manner or in a distributed manner andon, or via, any device able to provide and/or receive information.Further, although depicted in a particular manner, various modules orblocks may be repositioned without departing from the scope of thecurrent invention. Still further, although depicted in a particularmanner, a greater or lesser number of modules and connections can beutilized with the present invention in order to accomplish the presentinvention, to provide additional known features to the presentinvention, and/or to make the present invention more efficient. Also,the information sent between various modules can be sent between themodules via at least one of a data network, the Internet, an InternetProtocol network, a wireless source, and a wired source and viaplurality of protocols.

What is claimed is:
 1. A method, comprising: receiving a custom commandfor a module; generating, by an integrated development environmentstation, a custom component corresponding to the custom command;generating a capabilities component from the custom component and adefinition of an application programming interface for at least onesoftware development kit component to be included in the module;generating a software development kit component class corresponding tothe selected software development kit component; generating a devicecomponent class corresponding to the software development kit componentclass from the definition of the application programming interface; andgenerating a custom device component class corresponding to the customcomponent.
 2. The method of claim 1, comprising receiving selection ofthe at least one software development kit component.
 3. The method ofclaim 1, wherein the device component class and the custom devicecomponent class inherit from a device component base class.
 4. Themethod of claim 1, further comprising generating, by the integrateddevelopment environment station, a capabilities class.
 5. The method ofclaim 4, further comprising querying, by the capabilities class, thedevice component class and the custom device component class for arespective capabilities object.
 6. The method of claim 5, furthercomprising: receiving, by the capabilities class, a first capabilitiesobject from the device component class; and receiving, by thecapabilities class, a second capabilities object from the custom devicecomponent class.
 7. The method of claim 6, further comprising:generating a composite capabilities object by the capabilities classfrom the first capabilities object and the second capabilities object;and conveying, by the capabilities class, the composite capabilitiesobject to an Open Service Gateway initiative (OSGi) device class thatprovides an interface to the module.
 8. The method of claim 7, whereinthe composite capabilities object specifies the capabilities of each ofthe device component class and the custom device component class,wherein the capabilities include commands, parameters, and properties ofthe respective device component class and the custom device componentclass.
 9. The method of claim 1, comprising receiving a definition ofthe application programming interface for the at least one softwaredevelopment kit component.
 10. A non-transitory computer-readable mediumhaving computer-executable instructions for execution by a processingsystem that cause the processing system to: receive a custom command fora module; generate, by an integrated development environment station, acustom component corresponding to the custom command; generate acapabilities component from a definition of an application programminginterface and the custom component; generate a custom device componentclass corresponding to the custom component; generate, by the integrateddevelopment environment station, a capabilities class; and query, by thecapabilities class, the device component class and the custom devicecomponent class for a respective capabilities object.
 11. Thenon-transitory computer-readable medium of claim 10, havingcomputer-executable instructions for execution by the processing systemthat cause the processing system to generate selection of at least onesoftware development kit component.
 12. The non-transitorycomputer-readable medium of claim 10, wherein the device component classand the custom device component class inherit from a device componentbase class.
 13. The non-transitory computer-readable medium of claim 10,further comprising instructions that, when executed, cause theprocessing system to generate the definition of the applicationprogramming interface for the least one software development kitcomponent to be included in the module.
 14. The non-transitorycomputer-readable medium of claim 13, further comprising instructionsthat, when executed, cause the processing system to: receive, by thecapabilities class, a first capabilities object from the devicecomponent class; and receive, by the capabilities class, a secondcapabilities object from the custom device component class.
 15. Thenon-transitory computer-readable medium of claim 14, further comprisinginstructions that, when executed, cause the processing system to:generate a composite capabilities object by the capabilities class fromthe first capabilities object and the second capabilities object; andconvey, by the capabilities class, the composite capabilities object toan OSGi device class that provides an interface to the module.
 16. Thenon-transitory computer-readable medium of claim 15, wherein thecomposite capabilities object specifies the capabilities of each of thedevice component class and the custom device component class, whereinthe capabilities include commands, parameters, and properties of therespective device component class and the custom device component class.17. A system, comprising: a module configured to receive a customcommand; and an integrated development environment station configuredto: generate a custom component that corresponds to the custom command;generate a capabilities component from the custom component and adefinition of an application programming interface for at least onesoftware development kit component to be included in the module;generate a software development kit component class that corresponds tothe selected software development kit component; generate a devicecomponent class that corresponds to the software development kitcomponent class from the definition of the application programminginterface; and generate a custom device component class that correspondsto the custom component.
 18. The system of claim 17, wherein the moduleis configured to receive selection of the at least one softwaredevelopment kit component.
 19. The system of claim 17, wherein thedevice component class and the custom device component class inheritfrom a device component base class.
 20. The system of claim 17, whereinthe integrated development environment station generates a capabilitiesclass.